Przejdź do głównej zawartości

Instalacja CGC CLI

Jak zainstalować CGC CLI (pakiet pip cgcsdk), włączyć autouzupełnianie (tab completion) i zalogować się poleceniem cgc login.

Wymagania wstępne​

  • Python 3.11+

Windows​

Zainstaluj Pythona i dodaj go do zmiennej PATH.

Linux​

Zainstaluj Pythona i dodaj go do zmiennej PATH.

Instalacja CGC za pomocą pip​

CLI CGC jest dostępny jako pakiet pip.

pip install cgcsdk

PS D:\cgc-docs> pip install cgcsdk
Collecting cgcsdk
  Downloading cgcsdk-0.1.1-py3-none-any.whl (31 kB)
...
Installing collected packages: cgcsdk
  WARNING: The script cgc.exe is installed in 'C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts' which is not on PATH.
  Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
Successfully installed cgcsdk-0.1.1

Proszę zwrócić uwagę na komunikat na końcu procesu instalacji.

WARNING: The script cgc.exe is installed in 'C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.10_qbz5n2kfra8p0\LocalCache\local-packages\Python310\Scripts' which is not on PATH.

W takim przypadku proszę postępować zgodnie z instrukcją, jak dodać lokalizację do zmiennej PATH.

przykład dla powershell:

$env:Path += ';C:\Users\user\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\Scripts'

Pakiet tworzy katalog o nazwie cgcsdk w katalogu %APPDATA% (Windows) lub $XDG_CONFIG_HOME / $HOME/.config. Ten katalog będzie zawierał plik konfiguracyjny po ukończeniu kolejnego kroku.

CGC Tab Completion​

Ten krok jest opcjonalny, ale znacznie ułatwi Ci życie, dlatego zalecamy go wykonać.

mkdir -p ~/.local/share/bash-completion/completions
_CGC_COMPLETE=bash_source cgc > ~/.local/share/bash-completion/completions/cgc

Zrobione! Włącz ponownie terminal i możesz używać tab completion. Aby go przetestować, wpisz cgc i naciśnij tab.

Logowanie​

Konto zakłada administrator. Zaloguj się kontem firmowym (Keycloak albo dostawca tożsamości Twojej organizacji, np. Microsoft Entra ID):

cgc login

cgc login otwiera przeglądarkę. Inne opcje:

  • cgc login --device - bez lokalnej przeglądarki (np. przez SSH): otwórz wypisany adres na innym urządzeniu i wpisz kod.
  • cgc login --no-browser - wypisz adres zamiast otwierać przeglądarkę.

Po udanym logowaniu CLI zapisuje też kontekst kubectl, więc kubectl --context <nazwa> get pods działa z Twoją tożsamością. cgc logout usuwa zapisane tokeny.

Następnie wybierz namespace, w którym pracujesz:

cgc namespace list          # namespace'y przypisane do Ciebie; aktywny oznaczony *
cgc namespace use <nazwa>   # ustaw aktywny namespace

Nowe konto ma tylko swój osobisty namespace. Wspólne namespace'y przypisuje admin Twojej organizacji. Zobacz Namespace'y.

notatka

Jeśli Twoja organizacja ma własny serwer CGC (on-premise), CLI trzeba na niego skierować przed pierwszym logowaniem. Uruchom cgc context get-env-path i ustaw w tym pliku API_HOST, API_PORT i CGC_SECRET na wartości od administratora.